<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>s3.generator.S3Generator</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="s3-module.html">Package&nbsp;s3</a> ::
        <a href="s3.generator-module.html">Module&nbsp;generator</a> ::
        Class&nbsp;S3Generator
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="s3.generator.S3Generator-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class S3Generator</h1><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator">source&nbsp;code</a></span><br /><br />
<center>
<center>  <map id="uml_class_diagram_for_s3_gener" name="uml_class_diagram_for_s3_gener">
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#put_bucket_acl" title="s3.generator.S3Generator.put_bucket_acl" alt="" coords="19,38,536,56" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#create_bucket" title="Create a bucket." alt="" coords="19,56,536,75" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#make_bare_url" title="Make an unauthorised URL." alt="" coords="19,75,536,94" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#delete_bucket" title="Delete a bucket." alt="" coords="19,94,536,112" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="19,112,536,131" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#get_acl" title="Get acl information for an object." alt="" coords="19,131,536,150" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#put_acl" title="s3.generator.S3Generator.put_acl" alt="" coords="19,150,536,168" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#set_expires" title="Set absolute expiration time." alt="" coords="19,168,536,187" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#get_bucket_acl" title="Get acl information for a bucket." alt="" coords="19,187,536,206" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#get" title="s3.generator.S3Generator.get" alt="" coords="19,206,536,224" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#set_expires_in" title="Set relative expiration time from the url creation moment." alt="" coords="19,224,536,243" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#put" title="s3.generator.S3Generator.put" alt="" coords="19,243,536,262" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#list_bucket" title="List a bucket&#39;s content." alt="" coords="19,262,536,280" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#list_buckets" title="List all buckets" alt="" coords="19,280,536,299" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html#delete" title="s3.generator.S3Generator.delete" alt="" coords="19,299,536,318" />
<area shape="rect" href="s3.generator.S3Generator&#45;class.html" title="s3.generator.S3Generator" alt="" coords="7,7,548,324" />
</map>
  <img src="uml_class_diagram_for_s3_gener.gif" alt='' usemap="#uml_class_diagram_for_s3_gener" ismap="ismap" class="graph-without-title">
</center></center>
<hr />
<p>Generator class</p>
  Objects of this class are used for generating authenticated URLs for 
  accessing Amazon's S3 service.<br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">pub_key</span>,
        <span class="summary-sig-arg">priv_key</span>,
        <span class="summary-sig-arg">secure</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">host</span>=<span class="summary-sig-default">&quot;s3.amazonaws.com&quot;</span>,
        <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">None</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for 
      signature
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#set_expires_in" class="summary-sig-name">set_expires_in</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">expires_in</span>)</span><br />
      Set relative expiration time from the url creation moment.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#set_expires" class="summary-sig-name">set_expires</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">expires</span>)</span><br />
      Set absolute expiration time.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#make_bare_url" class="summary-sig-name">make_bare_url</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bucket</span>,
        <span class="summary-sig-arg">key</span>=<span class="summary-sig-default">''</span>)</span><br />
      Make an unauthorised URL.
  </td>
</tr>
<tr class="private">
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#_auth_header_value" class="summary-sig-name">_auth_header_value</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">method</span>,
        <span class="summary-sig-arg">path</span>,
        <span class="summary-sig-arg">headers</span>)</span>
  </td>
</tr>
<tr class="private">
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#_headers" class="summary-sig-name">_headers</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">length</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">expires</span>=<span class="summary-sig-default">None</span>)</span>
  </td>
</tr>
<tr class="private">
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#_params" class="summary-sig-name">_params</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">params</span>,
        <span class="summary-sig-arg">acl</span>=<span class="summary-sig-default">False</span>)</span>
  </td>
</tr>
<tr class="private">
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#_path" class="summary-sig-name">_path</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bucket</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">key</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">acl</span>=<span class="summary-sig-default">False</span>)</span>
  </td>
</tr>
<tr class="private">
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#_io_len" class="summary-sig-name">_io_len</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">io</span>)</span>
  </td>
</tr>
<tr class="private">
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#_generate" class="summary-sig-name">_generate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">method</span>,
        <span class="summary-sig-arg">bucket</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">key</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">send_io</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">params</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">acl</span>=<span class="summary-sig-default">False</span>)</span>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">string</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#create_bucket" class="summary-sig-name">create_bucket</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      Create a bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">string</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#list_bucket" class="summary-sig-name">list_bucket</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">params</span>=<span class="summary-sig-default">{}</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      List a bucket's content.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">string</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#delete_bucket" class="summary-sig-name">delete_bucket</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      Delete a bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">string</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#list_buckets" class="summary-sig-name">list_buckets</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      List all buckets
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#put" class="summary-sig-name">put</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bucket</span>,
        <span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">obj</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bucket</span>,
        <span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bucket</span>,
        <span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">string</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#get_bucket_acl" class="summary-sig-name">get_bucket_acl</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      Get acl information for a bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#get_acl" class="summary-sig-name">get_acl</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bucket</span>,
        <span class="summary-sig-arg">key</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      Get acl information for an object.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#put_bucket_acl" class="summary-sig-name">put_bucket_acl</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">acl_xml_document</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.generator.S3Generator-class.html#put_acl" class="summary-sig-name">put_acl</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bucket</span>,
        <span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">acl_xml_document</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>

<br />
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>

<br />
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">pub_key</span>,
        <span class="sig-arg">priv_key</span>,
        <span class="sig-arg">secure</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">host</span>=<span class="sig-default">&quot;s3.amazonaws.com&quot;</span>,
        <span class="sig-arg">port</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature
  <dl><dt></dt><dd>
    <dl><dt>Overrides:
      object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="set_expires_in"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_expires_in</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">expires_in</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.set_expires_in">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Set relative expiration time from the url creation moment.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>expires_in</code></strong> (int) - Relative expiration time</li>
    </ul>
  </dd></dl>
</td></tr></table>
</div>
<a name="set_expires"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_expires</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">expires</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.set_expires">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Set absolute expiration time.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>expires</code></strong> (time.time()) - Absolute expiration time</li>
    </ul>
  </dd></dl>
</td></tr></table>
</div>
<a name="make_bare_url"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">make_bare_url</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bucket</span>,
        <span class="sig-arg">key</span>=<span class="sig-default">''</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.make_bare_url">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Make an unauthorised URL.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="_auth_header_value"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_auth_header_value</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">method</span>,
        <span class="sig-arg">path</span>,
        <span class="sig-arg">headers</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator._auth_header_value">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="_headers"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_headers</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">length</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">expires</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator._headers">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="_params"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_params</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">params</span>,
        <span class="sig-arg">acl</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator._params">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="_path"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_path</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bucket</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">key</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">acl</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator._path">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="_io_len"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_io_len</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">io</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator._io_len">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="_generate"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">method</span>,
        <span class="sig-arg">bucket</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">key</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">send_io</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">params</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">acl</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator._generate">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="create_bucket"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">create_bucket</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.create_bucket">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Create a bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>name</code></strong> (string) - Name for the new bucket</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Additional headers</li>
    </ul>
    <dl><dt>Returns: string</dt>
        <dd>Authenticated URL for creating a bucket</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="list_bucket"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">list_bucket</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">params</span>=<span class="sig-default">{}</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.list_bucket">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />List a bucket's content.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>name</code></strong> (string) - Bucket's name</li>
        <li><strong class="pname"><code>params</code></strong> (dict) - Additional parameters</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Additional headers</li>
    </ul>
    <dl><dt>Returns: string</dt>
        <dd>Authenticated URL for listing bucket's content</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="delete_bucket"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete_bucket</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.delete_bucket">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Delete a bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>name</code></strong> (string) - Name of the bucket that should be deleted</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Additional headers</li>
    </ul>
    <dl><dt>Returns: string</dt>
        <dd>Authenticated URL for delete a bucket</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="list_buckets"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">list_buckets</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.list_buckets">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />List all buckets
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>headers</code></strong> (dict) - Additional headers</li>
    </ul>
    <dl><dt>Returns: string</dt>
        <dd>Authenticated URL for listing all buckets</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="put"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">put</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bucket</span>,
        <span class="sig-arg">key</span>,
        <span class="sig-arg">obj</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.put">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="get"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bucket</span>,
        <span class="sig-arg">key</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.get">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bucket</span>,
        <span class="sig-arg">key</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="get_bucket_acl"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_bucket_acl</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.get_bucket_acl">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Get acl information for a bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>name</code></strong> (string) - Bucket name</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Additional headers</li>
    </ul>
    <dl><dt>Returns: string</dt>
        <dd>Authenticated URL for getting acl information for a bucket</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="get_acl"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_acl</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bucket</span>,
        <span class="sig-arg">key</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.get_acl">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Get acl information for an object.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>bucket</code></strong> (string) - Bucket's name</li>
        <li><strong class="pname"><code>key</code></strong> (string) - Object's name</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Additional headers</li>
    </ul>
    <dl><dt>Returns:</dt>
        <dd>Authenticated URL for getting acl information for an 
          object</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="put_bucket_acl"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">put_bucket_acl</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">acl_xml_document</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.put_bucket_acl">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="put_acl"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">put_acl</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bucket</span>,
        <span class="sig-arg">key</span>,
        <span class="sig-arg">acl_xml_document</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.generator-pysrc.html#S3Generator.put_acl">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">Generated by Epydoc
        3.0alpha3 on Wed Sep 20 12:10:43 2006</td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
